DealsApi
All URIs are relative to **
| Method | HTTP request | Description |
|---|---|---|
| dealEstimatePost | POST /deal/estimate | Estimate the cost of a deal |
| dealInfoDealidGet | GET /deal/info/{dealid} | Get Deal Info |
| dealProposalPropcidGet | GET /deal/proposal/{propcid} | Get Proposal |
| dealQueryMinerGet | GET /deal/query/{miner} | Query Ask |
| dealStatusByProposalPropcidGet | GET /deal/status-by-proposal/{propcid} | Get Deal Status by PropCid |
| dealStatusMinerPropcidGet | GET /deal/status/{miner}/{propcid} | Deal Status |
| dealTransferInProgressGet | GET /deal/transfer/in-progress | Transfer In Progress |
| dealsFailuresGet | GET /deals/failures | Get storage failures for user |
| dealsMakeMinerPost | POST /deals/make/{miner} | Make Deal |
| dealsStatusDealGet | GET /deals/status/{deal} | Get Deal Status |
| publicDealsFailuresGet | GET /public/deals/failures | Get storage failures |
| publicMinersStorageQueryMinerGet | GET /public/miners/storage/query/{miner} | Query Ask |
dealEstimatePost
Estimate the cost of a deal
This endpoint estimates the cost of a deal
Example
dealEstimatePost
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Main.estimateDealBody | The size of the deal in bytes, the replication factor, and the duration of the deal in blocks |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dealInfoDealidGet
Get Deal Info
This endpoint returns the deal info for a deal
Example
dealInfoDealidGet dealid=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| dealid | integer | Deal ID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dealProposalPropcidGet
Get Proposal
This endpoint returns the proposal for a deal
Example
dealProposalPropcidGet propcid=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| propcid | string | Proposal CID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dealQueryMinerGet
Query Ask
This endpoint returns the ask for a given CID
Example
dealQueryMinerGet miner=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| miner | string | CID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dealStatusByProposalPropcidGet
Get Deal Status by PropCid
Get Deal Status by PropCid
Example
dealStatusByProposalPropcidGet propcid=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| propcid | string | PropCid |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dealStatusMinerPropcidGet
Deal Status
This endpoint returns the status of a deal
Example
dealStatusMinerPropcidGet miner=value propcid=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| miner | string | Miner | |
| propcid | string | Proposal CID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dealTransferInProgressGet
Transfer In Progress
This endpoint returns the in-progress transfers
Example
dealTransferInProgressGet
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dealsFailuresGet
Get storage failures for user
This endpoint returns a list of storage failures for user
Example
dealsFailuresGet
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dealsMakeMinerPost
Make Deal
This endpoint makes a deal for a given content and miner
Example
dealsMakeMinerPost miner=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| miner | string | Miner | |
| dealRequest | string | Deal Request |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dealsStatusDealGet
Get Deal Status
This endpoint returns the status of a deal
Example
dealsStatusDealGet deal=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| deal | integer | Deal ID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
publicDealsFailuresGet
Get storage failures
This endpoint returns a list of storage failures
Example
publicDealsFailuresGet
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
publicMinersStorageQueryMinerGet
Query Ask
This endpoint returns the ask for a given CID
Example
publicMinersStorageQueryMinerGet miner=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| miner | string | CID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]